# ssgs

A simple static blog generator written in POSIX `sh`.

* [Example.](https://notabug.org/ricardogj08/blog)

## Dependencies

* `sh`, `bash`, `zsh` or other shell like UNIX.
* GNU Coreutils, BusyBox, Toybox, sbase or other UNIX utilities.
* [smu - a Simple Markup Language.](https://github.com/Gottox/smu)

## Installation

```
cd ssgs
sudo cp ssgs /usr/local/bin
```

## Usage

```
mkdir myblog
cd myblog
ssgs -b
cat << EOF > src/about.md
# About me

Hi everyone!
EOF
ssgs -b
```

## Workflow

```
[myblog]
  |-[docs]
  |-[src]
  |-ssgs.cfg
```

* `docs`: contains your `html` blog after executing `ssgs -b`.
* `src`: write your `markdown` articles in this directory with `*.md` extension, supports subdirectories, images, videos, audios and other files.
* `ssgs.cfg`: contains config vars for your blog, see `ssgs.cfg.def` file.

## Thanks

* [ssg6 - Static site generator written in shell.](https://www.romanzolotarev.com/ssg.html)
* [Dylan Araps - Pure sh bible.](https://github.com/dylanaraps/pure-sh-bible)
* [sw - Suckless web framework.](https://github.com/jroimartin/sw)
* [bashblog - A single Bash script to create blogs.](https://github.com/cfenollosa/bashblog)

## License

```
ssgs -- A simple static blog generator written in POSIX sh.

Copyright (C) 2021-2024  Ricardo García Jiménez <ricardogj08@riseup.net>

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.
```
